home *** CD-ROM | disk | FTP | other *** search
/ Aminet 1 (Walnut Creek) / Aminet - June 1993 [Walnut Creek].iso / aminet / mus / edit / amisox30.lha / doc / soxscripts.doc < prev    next >
Text File  |  1993-02-05  |  4KB  |  118 lines

  1. Shell scripts for common conversions using Amiga SOX
  2.  
  3. These directories each contain 13 shell scripts for dealing with
  4. certain types of sound conversions more easily.  The directory "DOS"
  5. contains scripts for use under the AmigaDOS standard shell; "CSH"
  6. contains scripts for the Dillon/Drew/Borreo&Dieni/Mueller Csh, an
  7. emulation of the Unix csh shell.
  8.  
  9.  
  10. CSH USAGE
  11.  
  12.     If you use csh, install these scripts in any directory included in
  13.     your search path, and call them with the basename of the scriptname
  14.     (i.e., the same name as the corresponding dos script.  For au2iff.sh,
  15.     use au2iff on the command line).  Command syntax is as follows:
  16.  
  17.     XtoY <sourcefile>    #convert sourcefile OR sourcefile.X
  18.                 #to sourcefile.Y
  19.     XtoY <sourcefile>.ext    #convert sourcefile.ext to sourcefile.Y
  20.  
  21.     For example, to convert the u-law sound "spam.au" to VOC format, use
  22.     the command:
  23.  
  24.         au2voc spam
  25.             or
  26.         au2voc spam.au
  27.  
  28.     Unlike SOX itself, the scripts do NOT base file type on filename
  29.     extensions, so if you were to rename "spam.au" to "spam.snd", the
  30.     command
  31.  
  32.         au2voc spam.snd
  33.  
  34.     would perform the same operation.  All of the above commands would
  35.     create a VOC (Creative Voice) file named "spam.voc".
  36.  
  37.     In addition, the file "soxaliases.sh" contains a set of csh shell
  38.     aliases which perform the same operations as the scripts.  They can
  39.     be used interchangeably, and you need have only one method installed
  40.     at a time.
  41.  
  42.  
  43. DOS USAGE
  44.  
  45.     The AmigaDOS shell lacks many of the features of csh, and one of
  46.     them is the ability to add and remove filename extensions.  Thus
  47.     command syntax for the DOS scripts is necessarily a bit less
  48.     flexible than that of the csh scripts.  Generic syntax is:
  49.  
  50.     XtoY <sourcefile>    ;convert sourcefile.X to sourcefile.Y
  51.  
  52.     Note the absence of any filename extension in this syntax, as opposed
  53.     to the csh usage, in which source file extensions are ignored.
  54.  
  55.     The above example would be rendered in DOS as:
  56.  
  57.         au2voc spam
  58.  
  59.     and renaming the file "spam.au" to "spam.snd" would prevent you from
  60.     successfully converting the file.  Required filename extensions for
  61.     source files are:
  62.  
  63.         Type                    Extension
  64.         ----                    ---------
  65.         AIFF                    .aiff
  66.         Creative Voice (VOC)    .voc
  67.         IFF-8SVX                .iff
  68.         u-law                   .au
  69.         RIFF-WAVE               .wav
  70.  
  71.     These are also the default filename extensions for the converted
  72.     sound files under either shell.
  73.  
  74.     Another side effect of the DOS shell's lackof filename handling is
  75.     that specifying a full path name for a source file will cause sox to
  76.     use that path when creating the destination file, as well.  The csh
  77.     versions will always write the output to the current directory.
  78.  
  79.  
  80. STAT
  81.  
  82.     In addition, I have provided a script which performs the "stat"
  83.     operation on any file.  Usage is:
  84.  
  85.         stat <soundfile>
  86.  
  87.     filename handling is the same in either environment.
  88.  
  89.  
  90. OTHER FILES
  91.  
  92.     Several conversion scripts were added immediately prior to
  93.     distribution.  These are:
  94.  
  95.         mac52iff
  96.         mac72iff
  97.         mac112iff
  98.         mac222iff
  99.  
  100.     Each converts Macintosh-style unsigned linear raw sound files to
  101.     IFF-8SVX format, setting the rate according to the distinctive number
  102.     in the command name.  mac52iff converts Macintosh 5696 Hz sounds;
  103.     mac72iff converts 7596 Hz sounds; mac112iff converts at 11395 Hz; and
  104.     mac222iff works on 22790 Hz sounds.  You must determine through prior
  105.     knowledge or experimentation which is the correct sampling rate.  All
  106.     of the commands require a ".snd" filename extension in the AmigaDOS
  107.     version of the scripts.
  108.  
  109.  
  110. ETC
  111.  
  112.     Feel free to change these scripts to suit yourself, but please do
  113.     not redistribute them in modified form.  You may find them an aid in
  114.     creating your own series of easy conversion utilities.
  115.  
  116.  
  117. --dgc
  118.